/*
 * Copyright 2012-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.context.properties.source;

import java.util.function.Predicate;

import org.springframework.boot.origin.OriginTrackedValue;
import org.springframework.core.env.PropertySource;
import org.springframework.util.StringUtils;

/**
 * ConfigurationProperty 的数据源。
 *
 * @author Phillip Webb
 * @author Madhura Bhave
 * @since 2.0.0
 * @see ConfigurationPropertyName
 * @see OriginTrackedValue
 * @see #getConfigurationProperty(ConfigurationPropertyName)
 */
@FunctionalInterface
public interface ConfigurationPropertySource {

	/**
	 * 从源中返回单个 {@link ConfigurationProperty}，如果找不到则返回 {@code null}。
	 * @param name 属性名称（不能为空）
	 * @return 关联的 ConfigurationProperty 对象或 {@code null}
	 */
	ConfigurationProperty getConfigurationProperty(ConfigurationPropertyName name);

	/**
	 * 判断该源中是否包含指定名称的任何子孙属性。
	 * 可能返回 {@link ConfigurationPropertyState#PRESENT} 或 {@link ConfigurationPropertyState#ABSENT}
	 * 表示能确定的答案，或 {@link ConfigurationPropertyState#UNKNOWN} 表示无法确定。
	 * @param name 要检查的属性名称
	 * @return 属性状态，表示是否包含子孙属性
	 */
	default ConfigurationPropertyState containsDescendantOf(ConfigurationPropertyName name) {
		return ConfigurationPropertyState.UNKNOWN;
	}

	/**
	 * 返回该源的一个过滤变体，仅包含符合给定过滤条件的名称。
	 * @param filter 过滤条件谓词
	 * @return 过滤后的 {@link ConfigurationPropertySource} 实例
	 */
	default ConfigurationPropertySource filter(Predicate<ConfigurationPropertyName> filter) {
		return new FilteredConfigurationPropertiesSource(this, filter);
	}

	/**
	 * 返回支持名称别名的该源变体。
	 * @param aliases 根据名称返回别名流的函数
	 * @return 支持名称别名的 {@link ConfigurationPropertySource} 实例
	 */
	default ConfigurationPropertySource withAliases(ConfigurationPropertyNameAliases aliases) {
		return new AliasedConfigurationPropertySource(this, aliases);
	}

	/**
	 * 返回支持指定前缀的此源的变体。
	 * @param prefix 源中属性的前缀
	 * @return 支持前缀的 {@link ConfigurationPropertySource} 实例
	 * @since 2.5.0
	 */
	default ConfigurationPropertySource withPrefix(String prefix) {
		return (StringUtils.hasText(prefix)) ? new PrefixedConfigurationPropertySource(this, prefix) : this;
	}

	/**
	 * 返回实际提供属性的底层源。
	 * @return 底层属性源，或者 {@code null}。
	 */
	default Object getUnderlyingSource() {
		return null;
	}

	/**
	 * 从给定的 Spring {@link PropertySource} 适配出一个新的 {@link ConfigurationPropertySource}，
	 * 如果无法适配则返回 {@code null}。
	 * @param source 要适配的 Spring 属性源
	 * @return 适配后的配置属性源，或者 {@code null} {@link SpringConfigurationPropertySource}
	 * @since 2.4.0
	 */
	static ConfigurationPropertySource from(PropertySource<?> source) {
		if (source instanceof ConfigurationPropertySourcesPropertySource) {
			return null;
		}
		return SpringConfigurationPropertySource.from(source);
	}

}
